home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilConvPixel.z / ilConvPixel
Encoding:
Text File  |  2002-10-03  |  7.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll - a pixel that can be converted into different color models
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      iflPixel
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilConvPixel.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This class abstracts the concept of a pixel of image data with a
  19.      particular color model.  It contains the color model, data type, the
  20.      number of channels, and a list of component values.  Methods are provided
  21.      to covert this pixel to different color models.
  22.  
  23. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  24.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  25.  
  26.            ilConvPixel(iflDataType type, iflColorModel cm, double min,
  27.                        double max, iflColormap* map=NULL, void* data=NULL)
  28.            ilConvPixel(const iflPixel &pix, iflColorModel cm, double min,
  29.                        double max, iflColormap* map=NULL)
  30.            ilConvPixel(const ilConvPixel &pix, iflColorModel cm, double min,
  31.                        double max, iflColormap* map=NULL)
  32.  
  33.      CCCCoooonnnnvvvveeeerrrrssssiiiioooonnnn mmmmeeeetttthhhhooooddddssss
  34.  
  35.           void  doConversion(iflDataType type, iflColorModel cm, double min,
  36.                              double max, const iflColormap* map=NULL,
  37.                              const ilConvPixel* src=NULL)
  38.           void  operator=(const ilConvPixel &p)
  39.           void  setColorModel(iflColorModel cm)
  40.           void  setMinMax(double min, double max)
  41.           void  setType(iflDataType type)
  42.           void  setColormap(const iflColormap* map)
  43.  
  44.      AAAAcccccccceeeessssssss mmmmeeeetttthhhhooooddddssss
  45.  
  46.           iflColorModel  getColorModel()
  47.           void  getMinMax(double& min, double& max)
  48.           const iflColormap*  getColormap()
  49.  
  50.  
  51. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  52.      iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll(((())))
  53.  
  54.            ilConvPixel(iflDataType type, iflColorModel cm, double min,
  55.                        double max, iflColormap* map=NULL, void* data=NULL)
  56.            ilConvPixel(const iflPixel &pix, iflColorModel cm, double min,
  57.                        double max, iflColormap* map=NULL)
  58.            ilConvPixel(const ilConvPixel &pix, iflColorModel cm, double min,
  59.                        double max, iflColormap* map=NULL)
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))
  71.  
  72.  
  73.  
  74.           The first constructor creates a pixel of data type, _t_y_p_e, color
  75.           model _c_m, scaling range from _m_i_n to _m_a_x, color map _m_a_p (for
  76.           iflRGBPalette), and with the component values pointed to by _d_a_t_a.
  77.           The data values are copied into the ilConvPixel constructed.  The
  78.           second constructor copies the data from the iflPixel specified by
  79.           _p_i_x.  The third constructor converts the data from another
  80.           ilConvPixel (which may be in a different color model).
  81.  
  82.      ddddooooCCCCoooonnnnvvvveeeerrrrssssiiiioooonnnn(((())))
  83.  
  84.           void  doConversion(iflDataType type, iflColorModel cm, double min,
  85.                              double max, const iflColormap* map=NULL,
  86.                              const ilConvPixel* src=NULL)
  87.  
  88.  
  89.           This method converts the data in the source pixel, _s_r_c, to the
  90.           requested attributes specified by _t_y_p_e, _c_m, _m_i_n, _m_a_x and _m_a_p.  The
  91.           result is stored in this pixel.
  92.  
  93.      ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  94.  
  95.           iflColorModel getColorModel()
  96.  
  97.  
  98.           Returns the color model of this pixel.
  99.  
  100.      ggggeeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  101.  
  102.           const iflColormap*  getColormap()
  103.  
  104.  
  105.           Returns a pointer to the color map for this pixel (or NULL if there
  106.           isn't one).
  107.  
  108.      ggggeeeettttMMMMiiiinnnnMMMMaaaaxxxx(((())))
  109.  
  110.           void  getMinMax(double& min, double& max)
  111.  
  112.  
  113.           Returns the scaling min/max of this pixel in _m_i_n and _m_a_x.
  114.  
  115.      ooooppppeeeerrrraaaattttoooorrrr====(((())))
  116.  
  117.           void  operator=(const ilConvPixel &pix)
  118.  
  119.  
  120.           Copies and converts the source pixel _p_i_x, into the color model and
  121.           type of this pixel.
  122.  
  123.      sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllCCCCoooonnnnvvvvPPPPiiiixxxxeeeellll((((3333))))
  137.  
  138.  
  139.  
  140.           void  setColorModel(iflColorModel cm)
  141.  
  142.  
  143.           Converts this pixel to the color model specified by _c_m.
  144.  
  145.      sssseeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  146.  
  147.           void  setColormap(const iflColormap* map)
  148.  
  149.  
  150.           Sets the color map for this pixel to _m_a_p, the color map is not
  151.           copied.
  152.  
  153.      sssseeeettttMMMMiiiinnnnMMMMaaaaxxxx(((())))
  154.  
  155.           void  setMinMax(double min, double max)
  156.  
  157.  
  158.           Converts this pixel to the scaling range specified by _m_i_n and _m_a_x.
  159.  
  160.      sssseeeettttTTTTyyyyppppeeee(((())))
  161.  
  162.           void  setType(iflDataType type)
  163.  
  164.  
  165.           Converts this pixel to the data type specified by _t_y_p_e.
  166.  
  167. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  168.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiiffffllllPPPPiiiixxxxeeeellll
  169.      convert(), getData(), getDataType(), getElem(), getNumChans(), max(),
  170.      min(), operator!=(), operator=(), operator==(), operator[](), set(),
  171.      setElem()
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.